home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / door / hsldr25b.zip / HSLDOOR.DOC < prev    next >
Text File  |  1992-01-04  |  15KB  |  329 lines
  1.                           ┌─────────────┐
  2.                           │ HSLDOOR.EXE │
  3.                           └─────────────┘
  4.                                  
  5.              HS/Link Bi-Directional File Transfer Door
  6.                             Tom Kellen
  7.                    ßETATech Computer Consulting
  8.                            Version 0.23ß
  9.  
  10. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  11.  
  12. PURPOSE:  To provide a means for Spitfire SysOps to implement
  13.           HS/Link's Bi-Directional file transfers. 
  14.  
  15.  
  16.  
  17. INTRODUCTION:
  18.  
  19. I've just begun playing with Samuel Smith's HS/Link file transfer
  20. protocol.  So far it has yielded impressive results, but alas,
  21. Spitfire BBS does not yet implement support for Bi-Directional
  22. protocols.  HSLDoor should make full use of this protocol on a
  23. Spitfire BBS possible.
  24.  
  25.  
  26.  
  27. INSTALLATION:
  28.  
  29. HSLDoor assumes that you have read the documentation for HS/Link
  30. and have used HSCONFIG to configure your copy of HS/Link.  HSLDoor
  31. imposes very little control over HS/Link.  HSLDoor also assumes
  32. that HSLINK.EXE resides in a directory that is on your PATH (hmmm,
  33. that's a lot of assumptions).
  34.  
  35. Create a directory for HSLDoor.  For documentation purposes we will
  36. assume that you are using C:\SF\HSLDR.  Copy HSLDOOR.EXE and
  37. HSLDOOR.CFG into this directory.
  38.  
  39. You will need to modify at least 2 lines in HSLDOOR.CFG (any text
  40. after the ; are considered comments and ignored).  Here is an
  41. example configuration file:
  42.  
  43. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  44. BBS=The Paradigm BBS; Your BBS Name
  45. REGNO=000000; Registration Number, leave as 000000 if unregistered
  46. DEST=F:\UP\; Final destination for uploaded files
  47. LOG=C:\LOGS\HSLDOOR.LOG; Log to this file instead of CALLERS.TMP
  48. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  49.  
  50. The first line is the name of your BBS.  This will be displayed as
  51. the door closes and will also be displayed on all menus once you
  52. register the door.
  53.  
  54. The second line is your registration number.  If you are still
  55. evaluating the door and have not registered, leave this as 000000.
  56.  
  57. The third line is the destination path for all the files uploaded
  58. through HSLDoor.
  59.  
  60. The fourth line is an alternate log file.  By default HSLdoor logs
  61. to CALLERS.TMP for the node that called it so that all information
  62. will be placed in CALLERS.LOG.  If you wish logging for this door
  63. to go elsewhere, add a line like above using the key word LOG=. 
  64. This line is optional and if omitted, all logging will go to your
  65. caller's log.
  66.  
  67. If you don't want to have the beeps the door makes echoed on the
  68. local side (ie. sweet silence mode) then place the key word NOBEEP
  69. on a line in HSLDOOR.CFG.
  70.  
  71. By default the door allows users to log off following a file
  72. transfer.  The door will log this but Spitfire will also place a
  73. line stating "Improper return from door...".  This just means that
  74. the door dropped carrier.  If you wish to disable the ability for
  75. users to log off via the door, place the key word NOLOGOFF on a
  76. line in your HSLDOOR.CFG file.
  77.  
  78. As an added bonus to your users, you have the option to allow them
  79. free downloads to encourage the use of HS/Link and HSLDoor.  By
  80. default, the door credits uploads and downloads just the same way
  81. Spitfire does.  If you wish to allow the users to download through
  82. the door and not be charged for the downloads, place the key word
  83. FREEDL on it's own line in HSLDOOR.CFG.  If this key word is
  84. present, the users will not be charged for their downloads.
  85.  
  86. The lines in your HSLDOOR.CFG file (and it must be called this) can
  87. be in any order but they must start with the key words BBS=,
  88. REGNO=, DEST=, LOG=, NOBEEP, NOLOGOFF, and FREEDL.  The first 3 are
  89. required, the 4th - 7th are optional.
  90.  
  91. Once you have completed this, you will need to modify your SF.BAT
  92. to install this door.  This is pretty straight forward, and like
  93. any other Spitfire door.  Here is a snippet from my SF.BAT:
  94.  
  95. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  96. :DOOR_H
  97. REM HS/Link Transfer Door
  98. cd\sf\hsldr
  99. copy c:\sf\sfdoors.dat
  100. HSLDOOR
  101. erase sfdoors.dat
  102. CD \SF
  103. GOTO LOOP
  104. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  105.  
  106. This snippet is also included in the distribution ZIP as SF.BAT. 
  107. Just remember to copy SFDOORS.DAT (or one of the other SFxxxx.DAT
  108. files if running from a menu) to the HSLDoor's directory.  HSLDoor
  109. needs this information and will update the master copy in your node
  110. directory after it has run.  If you are running multiple nodes of
  111. Spitfire you can call HSLDOOR with a /DAT= on the command line
  112. indicating the path to the SFDOORS.DAT file you wish to use.  (ie.
  113. HSLDOOR /DAT=C:\SF01)  When you use /DAT= on the command line you
  114. do NOT have to copy the .DAT file to the HSLDoor directory.  This
  115. should allow multiple nodes to access the same copy of HSLDOOR.EXE. 
  116. HSLDoor can also be run from a menu extension.  It is able to read
  117. all of the .DAT files (SFDOORS.DAT, SFMAIN.DAT, SFMESS.DAT and
  118. SFFILE.DAT).  Just make sure you copy the correct one or indicate
  119. the path to the file using /DAT=.
  120.  
  121. NOTICE:   HSLDoor will NOT operate correctly under WildFire. 
  122.           WildFire does not faithfully recreate the SFxxxxx.DAT
  123.           files and all the information that HSLDoor needs to
  124.           operate is not contained in the .DAT files it creates.
  125.  
  126. The final step is to edit your SFDOOR.MNU file and add a line for
  127. this door.  See your Spitfire manual if you need more information
  128. on this.
  129.  
  130. That should get you going.
  131.  
  132.  
  133.  
  134. OPERATION:
  135.  
  136. The first time HSLDoor is run it will create a directory under it's
  137. home directory called HSLTRxx.WRK (the xx is replaced with the node
  138. number calling HSLDoor, ie. HSLTR01.WRK).  HSLDoor uses this
  139. directory during file transfers.  DO NOT use this directory or copy
  140. any files to it as HSLDoor deletes all the contents when it is
  141. through working.
  142.  
  143. When a user runs HSLDoor, it reads the SFDOORS.DAT file to get all
  144. the vital information.  It then goes out and get's a list of all
  145. the directories that this user should have access to based on the
  146. information you have configured for your BBS (this is stored in
  147. SFFAREA.DAT).
  148.  
  149. From the door's main menu, the user has 5 choices.
  150.  
  151. [ D ]     takes the user to a menu where they can work with files
  152.           for download.  The Download menu has 7 options.  
  153.  
  154.      [ A ]     This allows the user to create a list of files to
  155.                download.  It will create a listing of up to 100
  156.                files or the maximum allowed for that user, based on
  157.                time and daily download limits.  If the file is
  158.                available to the user, it is added to their list and
  159.                they are notified of the byte size of the file.
  160.      [ E ]     The user can use this option to edit their queue of
  161.                download files to remove some if necessary.
  162.      [ F ]     This is a simple file find that allows wildcard file
  163.                name entry.  The user will be prompted whether they
  164.                wish to add the files found to their download queue.
  165.      [ L ]     This presents a listing of the files currently in
  166.                the user's download queue.
  167.      [ S ]     The user can begin their HS/Link file transfer from
  168.                this menu by selecting this option.
  169.      [ U ]     This will change the user to the Upload Menu.
  170.      [ Q ]     And of course we can quit back to the main menu.
  171.  
  172. [ U ]     takes the user to a menu where they can manage the files
  173.           they intend to upload.
  174.  
  175.      [ A ]     Allows the user to create a list of the files they
  176.                will upload.  They are prompted for file name and a
  177.                45 character file description.  The file names are
  178.                checked against the files currently on the BBS and
  179.                duplicates are rejected.  SFNOUP.DAT is also checked
  180.                and files found on this list are rejected.  If you
  181.                have set description conversion on for your BBS,
  182.                HSLDoor will also change the file descriptions to
  183.                proper case and upper case any words founds in
  184.                SFUPCASE.DAT.  If the user starts the description
  185.                with a '\' character the upload is considered
  186.                private and for the sysop only.  The file will be
  187.                copied to the area defined in your HSLDOOR.CFG file,
  188.                but instead of the SFFILES.BBS listing in that
  189.                directory being updated, HEYSYSOP.LOG in your work
  190.                directory will be updated with the file information.
  191.      [ D ]     This will take the user to the Download Menu.
  192.      [ E ]     Using this option the user can edit their list of
  193.                files to upload and delete entries if needed.
  194.      [ L ]     This option will allow the user to view the list of
  195.                files they have queued for upload.
  196.      [ S ]     The user can start their HS/Link transfer from this
  197.                menu by selecting this option.
  198.      [ Q ]     This option returns the user to the main menu.
  199.  
  200. [ V ]     Allows the user to browse the file listings from the BBS. 
  201.           They will be presented with the descriptions of the file
  202.           areas available to them.  They can enter the number of a
  203.           file area to view, or page forward in the description
  204.           list with <N> or back in the list with <P>.  <Q> will
  205.           return the user to the main menu.
  206.  
  207. Once the user has completed creating their upload and download
  208. queues they can select [ S ] start their HS/Link transfer.  All of
  209. the files uploaded will go into the HSLTRxx.WRK directory.  Once
  210. the transfer is completed, HSLDoor will check the files uploaded
  211. with the list the user provided.  If they uploaded different files,
  212. the user will be asked to provide a description for those files. 
  213. Once the door has all the descriptions for all the files, they will
  214. be moved from the HSLTRxx.WRK directory to the destination
  215. directory you specified in the HSLDoor configuration file.  The
  216. SFFILES.BBS file (or HEYSYSOP.LOG if a private upload) in this
  217. directory will also be updated with the file name, size, date
  218. uploaded, and description.
  219.  
  220. The final [ Q ] option exits the user from the door.
  221.  
  222. HSLDoor will log it's transactions to your caller's log for
  223. informational purposes.  When the user exits the door, HSLDoor will
  224. update the master copy of SFDOORS.DAT so that the user is credited
  225. for their uploads and downloads.
  226.  
  227. HSLDoor will also credit the user for time on uploads based on how
  228. you have Spitfire configured to credit time for uploads.  HSLDoor
  229. looks to see if you have any upcoming On-Time events and will make
  230. sure that the user's time credit does not take them beyond this On-
  231. Time event.  If they amount of time they should be credited is
  232. greater than the time to the next On-Time event, then the user will
  233. only be credited with the amount of time remaining until the On-
  234. Time event.
  235.  
  236. There are several options available to the SysOp.  HSLDoor will
  237. take input from the local side so that if the user needs some help
  238. you can do some typing for them.
  239.  
  240. Hitting the ESC key, will immediately abort the door and send the
  241. user back to the BBS.  You can press F1 and get a short help screen
  242. of the keys available to the SysOp.  Use caution here though, as
  243. input from the user will not be processed while this screen is up
  244. (their keystrokes will be processed as soon as you remove the help
  245. screen).  The help screen has a 10 second time out on it and will
  246. remove its self after that timeout.
  247.  
  248. F3 allows the SysOp to take the user into a chat window.  Here they
  249. can type back and forth for discussion.  The text in both
  250. directions is word wrapped for legibility, and incoming and
  251. outgoing text are different colors on the local side to help
  252. visually differentiate them.  To exit chat mode, type ALT/F3 (or
  253. ALT/X).  While the user is in chat mode, the no keystroke timeout
  254. is disabled, but the user's door time continues to tick away.  The
  255. local side of this chat window is an ANSI screen with a 200 line
  256. scroll back buffer that can  be accessed with cursor and PgUp/PgDn
  257. keys.  You can also type ALT/S and the contents of the capture
  258. window buffer (up to 200 lines of chat) will be saved to a file
  259. called HSLDOOR.CAP.
  260.  
  261. F6 will give the user an additional 5 minutes of time in the door.
  262. F7 will take 5 minutes from the user.  If there is less than 5
  263. minutes left, time will be removed in 1 minute increments.
  264.  
  265. F9 will return the user to the BBS with a message saying that the
  266. SysOp has requested them to return.  F10 will return the user to
  267. the BBS with NO message.
  268.  
  269. HSLDoor keeps track of the user's time left in the door and also
  270. estimates the time for file transfers to attempt to limit the
  271. user's downloads to the time available.  HSLDoor also has a 3
  272. minute no keystroke timer.  The user will be issued messages at 2
  273. min., 1 min. and 30 seconds and then is returned to the BBS.
  274.  
  275. That's about all there is at this time.  Comments and suggestions
  276. are certainly welcomed.  I'd like to make this door as useful as
  277. possible.
  278.  
  279.  
  280.  
  281. EPILOGUE:
  282.  
  283. This is a SHAREWARE utility.  The program is NOT crippled and NO
  284. features are disabled.  Sending in the $5.00 US registration fee
  285. with the registration form to the address below will get you a
  286. registration number that will remove the [Unregistered Shareware
  287. Version] message and allow your BBS name to be displayed.  
  288.  
  289. Try the door thoroughly until you know in your heart that it is of
  290. use to you, and then send in the registration form and fee.  If it
  291. isn't, please let me know what features might improve the door.
  292.  
  293. HS/Link is Copyright by Samuel H. Smith and you are highly
  294. encouraged to register this superb file transfer protocol. 
  295. Spitfire is Copyright by Mike Woltz and is a registered trademark
  296. of Buffalo Creek Software.  It is also assumed that you have
  297. registered your copy of Spitfire as this is one superb BBS program.
  298.  
  299.  
  300.  
  301. AUTHOR CONTACT:
  302.  
  303. Problems, solutions, kudos and ideas are welcomed.  I can be
  304. reached at the following:
  305.  
  306. The Paradigm BBS                   ßETATech Computer Consulting
  307. 404/671-1581                       P. O. Box 566742
  308. 1200-19,200 Baud 24 Hrs/Day        Atlanta, GA  31156-6013
  309.  
  310.  
  311.  
  312. DISCLAIMER:
  313.  
  314. Use of this program acknowledges this disclaimer of warranty: "This
  315. program is supplied as is.  ßETATech Computer Consulting disclaims
  316. all warranties, express or implied, including, without limitation,
  317. the warranties of merchantability and of fitness of this program
  318. for any purpose.  ßETATech Computer Consulting assumes no liability
  319. for damages direct or consequential, which may result from the use
  320. of this program."
  321.  
  322.  
  323.  
  324. REVISION HISTORY:
  325.  
  326. 26-NOV-1991    v0.02ß         VERY ßeta Initial Release.
  327.  
  328. See WHATSNEW.TXT for further release and update information.
  329.